home *** CD-ROM | disk | FTP | other *** search
/ HPAVC / HPAVC CD-ROM.iso / pc / DDPLUS71.ZIP / IBBS.ZIP / IBBS.DOC < prev    next >
Encoding:
Text File  |  1995-03-23  |  11.4 KB  |  244 lines
  1.                           IBBS - An InterBBS Unit
  2.                       Copyright (c)1993-95 Andy Stewart
  3.  
  4.  
  5.  
  6.                                 Introduction
  7.                                 =---====---=
  8.  
  9.       What is InterBBS?  In it's simplest explanation, it's the ability
  10.       for a BBS Door to share it's scores with a number of other BBS'.
  11.       Yup, that's about as simple an explanation as you can get.  But this
  12.       is NOT the only use for an InterBBS package.  The complexity for
  13.       the InterBBS portion of your Door is only limited by two things:
  14.       your imagination and programming ability.  (Ok, three... patience)
  15.       <g>.  You could go as far as to create a Space Door, and treat
  16.       each BBS as it's own galaxy/government where you send attack fleets,
  17.       spys, diplomats, start wars, sign treaties, discover new planets,
  18.       create space stations, explore uncharted territory, etc.  (You know,
  19.       your basic Star Trek / Star Wars / Babylon 5 sorta game <g>).
  20.  
  21.  
  22.  
  23.                                Copyright Info
  24.                                =----====----=
  25.  
  26.       The IBBS.PAS code included in the archive is Freeware and can be
  27.       used in any manner you wish and without cost, but remains copyrighted
  28.       by Andy Stewart.  You may NOT distribute modified copies of this
  29.       unit!  You may, however, send your changes/fixes/etc. to Andy Stewart
  30.       (1:2230/146) or Bob Dalton (1:391/3010) for possible inclusion in
  31.       the next release of IBBS/DDPlus.
  32.  
  33.  
  34.  
  35.                                 Requirements
  36.                                 =---====---=
  37.       At this point only requirements are that you must be using Turbo
  38.       Pascal v6.0 or 7.0.  I compiled the unit with Turbo Pascal v7.0 and
  39.       know it works. I expect it will with TP v6.0 and BP v7.0 as well but
  40.       can't guarantee it.  IBBS.PAS does NOT rely on DDPLUS.PAS, everything
  41.       it needs is either self contained, or comes with your compiler.
  42.  
  43.       To USE the InterBBS package, you need a copy of PKZIP.EXE and
  44.       PKUNZIP.EXE in your path.  Be SURE to tell the Sysop using your
  45.       Door that these two files are REQUIRED for InterBBS use!  You also
  46.       need to be running a front door system (ie: FrontDoor, InterMail,
  47.       Binkley, etc.) and be in a FidoNet compatable network.  This unit
  48.       ONLY works with a Fidonet style network.
  49.  
  50.  
  51.  
  52.                                 Files Included
  53.                                 =----====----=
  54.  
  55.         -  Below is a listing of all files for the IBBS.ZIP Package -
  56.  
  57.          IBBS.DOC     - This text file.
  58.          IBBS.CFG     - Sample configuration file for the IBBS unit.
  59.          ROUTE.CFG    - Sample routing configuration file.
  60.          IBBSDEMO.EXE - Compiled version of the IBBSDEMO.PAS program. Just
  61.                         a little demo of how to use the IBBS unit.  You'll
  62.                         need to edit IBBS.CFG first to reflect your paths.
  63.                         Actually, it won't do anything because it won't
  64.                         find any *.MSG files to it or any files to be sent.
  65.          IBBSDEMO.PAS - Source code to the IBBSDEMO.EXE program.
  66.          IBBS.PAS     - The InterBBS unit.
  67.          READMSGS.PAS - Sample source code for reading all messages.
  68.  
  69.  
  70.                       Installation and Preparation for Use
  71.                       =-----------============-----------=
  72.  
  73.          1) Move the archive package to a temporary directory and UNZip it.
  74.  
  75.          2) Edit the IBBS.CFG to reflect your paths, etc.
  76.  
  77.          3) Try the IBBSDEMO.EXE program just for the 'ell of it.
  78.             It accepts 3 different parameters:  IN, OUT, and HUB.
  79.  
  80.             IBBSDEMO IN will scan all *.MSG files in your 'netmail' directory
  81.             for any messages to the Door, and copy the file(s) attached to
  82.             the 'inzip' directory.  (It won't FIND any *.MSG files to it on
  83.             this run, but it'll give ya an idea.)  Then, if any files exist
  84.             in the 'inzip' directory, it will unzip them into the 'infiles'
  85.             directory.  The *.MSG files to the Door will be deleted after
  86.             use, and the ZIP(s) will be deleted after they are UNZip'd.
  87.  
  88.             IBBSDEMO OUT will scan your 'outfiles' directory, and if any
  89.             files exist, it will create a ZIP called 13913010.ZIP in the
  90.             'outzip' directory, and create a *.MSG in your 'netmail'
  91.             directory with TEST.ZIP as a file attach with all the correct
  92.             flags for Fido.   All files that were ZIP'd into .13913010ZIP
  93.             will be deleted.
  94.  
  95.             IBBSDEMO HUB will scan your 'outfiles' directory, and if any
  96.             files exist, it will read each line in ROUTE.CFG, and create a
  97.             ZIP based on the name in the second field of the line into the
  98.             'outzip' directory, and create a *.MSG in your 'netmail'
  99.             directory with the file as a file attach with all the correct
  100.             flags for Fido.   After reading all of ROUTE.CFG, all files
  101.             that were ZIP'd into the files will be deleted.
  102.  
  103.          4) Before compiling the IBBS.PAS unit be sure that your compiler
  104.             knows where to find the listed units.
  105.  
  106.          5) Add IBBS to the 'Uses' portion of your program and call the
  107.             procedures as needed and shown below.
  108.  
  109.          6)  That's it!  Enjoy and good luck.
  110.  
  111.  
  112.                           Configuration Files Explained
  113.                           =-------=============-------=
  114.  
  115. (* Begin IBBS.CFG *)
  116. 1:2230/146
  117. 1:391/3010
  118. DreamROM
  119. C:\FD\NETMAIL\
  120. C:\FD\FILE\
  121. INFILES\
  122. OUTFILES\
  123. OUTZIP\
  124. INZIP\
  125.  
  126. (**************  IBBS.CFG - Everything after line 9 is ignored. ************)
  127. Line 1:  Your Net Address
  128. Line 2:  The To Net Address
  129. Line 3:  This Door's Name
  130. Line 4:  Netmail Path
  131. Line 5:  Incoming File Path
  132. Line 6:  Name Of Directory To Uncompress Incoming Files To
  133. Line 7:  Name Of Directory Holding Outgoing Files To Be Compressed
  134. Line 8:  Name Of Directory Holding Compressed Outgoing Files
  135. Line 9:  Name Of Directory Holding Compressed Incoming Files
  136. (* End IBBS.CFG *)
  137.  
  138.  
  139. (* Begin ROUTE.CFG *)
  140. 1:398/2;ARTI
  141. 1:105/278;WCS
  142. 1:137/201;WOODLAND
  143. 1:115/258;STATION1
  144. 1:246/93;FIREHSE
  145. ; ---------------------------------------------------------
  146. ; Format for ROUTE.CFG is:
  147. ; TO_ADDRESS:FILENAME
  148. ; IE:  In line one above, all files in the outfiles directory
  149. ;      will be ZIP'd into ARTI.ZIP and sent to 1:398/2
  150. ;
  151. ; All lines beginning with ; are ignored.
  152. (* Begin END.CFG *)
  153.  
  154.  
  155.                           How To Use The InterBBS Unit
  156.                                 And How It Works
  157.                           =-------============-------=
  158.  
  159.       The InterBBS unit handles all the transfers of InterBBS packets
  160.       between systems.  An InterBBS packet can be scores, messages, files,
  161.       etc., it doesn't matter and the unit doesn't care.  Your Door handles
  162.       the USE of the packets send to and from systems using the InterBBS
  163.       package, IBBS will NOT process them for you, as it's impossible for
  164.       me to know the format, what they are, what's supposed to be done with
  165.       them, etc.  IBBS just gathers them, compresses them sends them to the
  166.       system, takes files from the system, and uncompresses them.
  167.  
  168.       To send InterBBS files via IBBS.PAS:
  169.  
  170.        Your Door MUST place all files to be sent to the remote system via
  171.        IBBS in the OUTFILES directory.  The files can be ANYTHING, but MUST
  172.        be in the OUTFILES dir.  Call procedure make_ibbs_outgoing(); like
  173.        so:  make_ibbs_outgoing('FILENAME'); where FILENAME is the filename you
  174.        want created (ZIP'd) and sent.  To base it on the to_system_address,
  175.        call it as make_ibbs_outgoing(convert_address(to_system_address));
  176.        Do NOT add the '.ZIP' extension!  Make_ibbs_outgoing will ZIP create
  177.        the zipfile, then create a *.MSG file in your NETMAIL directory with
  178.        C:\DOORPATH\OUTZIP\FILENAME.ZIP attached to it. (C:\DOORPATH is your
  179.        current Door's directory, which is obtained at the start of the unit).
  180.        It will set the correct flags for the *.MSG file, which are:  Pvt,
  181.        Crash, Attached, Kill/Sent, Local, Direct, Delete/Sent.  It will add
  182.        IBBS, INTL, FLAGS, and TID: lines to the top of the text portion of
  183.        the message.  These are used by the front door program and/or by IBBS.
  184.        Your front door program takes it from here.
  185.  
  186.       To receive InterBBS files via IBBS.PAS:
  187.  
  188.        Call get_ibbs_incoming;  Get_ibbs_incoming will scan your NETMAIL
  189.        directory for all *.MSG files address to the Door.  (*.MSG identity
  190.        is determined by several factors including System Address, To Field,
  191.        and the IBBS line).  If any *.MSG files to it are found, the attached
  192.        file is moved from your FILES directory to the INZIP directory and
  193.        the *.MSG is deleted.  Your INZIP directory will next be scanned for
  194.        for any ZIP files.  If any exist, they will be unzip'd into your
  195.        INFILES directory and the ZIP file(s) will be deleted.  This is where
  196.        your program takes over.
  197.  
  198.       To use the 'HUB' feature:
  199.  
  200.        This is the same as INTERBBS OUT except it creates multiple *.MSG
  201.        and ZIP files.  The systems and filenames are taken from ROUTE.CFG.
  202.        To use this feature, call make_multi_ibbs_outgoing;  This can be used
  203.        in a couple different ways.  Either you can set up one system to be
  204.        a hub where all systems send their packets to it, it processes them
  205.        and sends the processed packets out to all systems.  Or, each system
  206.        could send thier packet to each system in the InterBBS network.  This
  207.        will be expanded on in later version.  See Future Directions.
  208.  
  209.      You can integrate the IBBS into your Door in two ways.  You can:
  210.  
  211.      1) Use it internally and call in incoming procedures as the user
  212.         enters the door and the outgoing procedures are the user exists
  213.         the door.  (This is ok if your InterBBS routines are just simple
  214.                     ones like score sharing, etc.  Anything MAJOR will
  215.                     cause the user to wait and they can become VERY
  216.                     impatient waiting on it to finish.  This isn't
  217.                     a recommended method of handling InterBBS files).
  218.  
  219.      2) Create an InterBBS EXE similar to IBBSDEMO.EXE and use it in your
  220.         frontdoor's batchfile. For example, after mail is received, the
  221.         front door program drops with an errorlevel, this is where you'd
  222.         run the EXE.  (This is the recommended method)
  223.                      IBBSDEMO IN  { To check for incoming *.MSG files }
  224.                      IBBSDEMO OUT { To create outgoing *.MSG files }
  225.                      IBBSDEMO HUB { To create multiple *.MSG files }
  226.  
  227.  
  228.                                Future Directions
  229.                           =-------============-------=
  230.  
  231.      This InterBBS kit will be kept as Freeware (as far as I can tell <g>),
  232.      but will remain copyrighted to myself.  Refer back to Copyright Info.
  233.  
  234.      In future versions, the 'HUB' feature will be expanded upon.  I'm
  235.      working on adding a routing grid for use with the kit which will be
  236.      added to the kit at a later date.
  237.  
  238.  
  239.           Enjoy the InterBBS package, and I hope it's of use to you.
  240.  
  241.  
  242.                                     Andy Stewart
  243.                                     DreamWARE Communications
  244.                                     1:2230/146